-
Notifications
You must be signed in to change notification settings - Fork 22
Update README documentation with AgentScope Studio integration and reorganized framework list #99
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
@copilot 刚才还没说完: |
I've completed both changes:
Changes committed in 87bedf0. |
|
@copilot 还需要吧 AgentScope 框架的数据上报到 AgentScope Studio,你具体可以参考 https://github.com/alibaba/loongsuite-python-agent/tree/main/instrumentation-loongsuite/loongsuite-instrumentation-agentscope 这个文档 |
I've added a new subsection "Export AgentScope Data to AgentScope Studio" with configuration details showing how to export telemetry data using OTLP. The section includes:
Changes committed in de72ccf. |
|
@copilot 当前还不支持 metrics 的收集,先把 metrics 的端点给去掉 |
Removed all metrics-related configuration from the AgentScope Studio section:
Changes committed in af9af05. |
|
@copilot 还有两个关于 readme 文档的需求
|
Completed both updates:
Also fixed guide paths to point to instrumentation-loongsuite for frameworks that were moved there. Changes committed in 2e5a095. |
|
@copilot 不太对,你需要把 opentelemetry-instrumentation-开头的插件和 loongsuite-instrumentation-开头的插件分开,在 README 中只体现 loongsuite-instrumentation-开头的插件,可以说明一下 opentelemetry 插件是上游的,我们只是做了同步。loongsuite 开头的才是新增的 |
Reorganized the "Supported AI Frameworks and components" section with two distinct groups: LoongSuite enhanced instrumentations (loongsuite-instrumentation-*):
Upstream OpenTelemetry instrumentations (opentelemetry-instrumentation-*):
Added explanatory text to clarify that upstream plugins are synchronized from OpenTelemetry, while loongsuite plugins are new additions. Changes committed in 4d92ca7. |
… section Change-Id: Ia89adef07971514e8667a6101c1b60dc4ca88895 Co-developed-by: Cursor <[email protected]> Co-authored-by: ralf0131 <[email protected]>
Change-Id: I038ee5920f8d33892d1b9163b6877a235803b711 Co-developed-by: Cursor <[email protected]> Co-authored-by: ralf0131 <[email protected]>
Change-Id: I36497b1c2c17a74b0702dc418e4f3c02dd460242 Co-developed-by: Cursor <[email protected]> Co-authored-by: ralf0131 <[email protected]>
Change-Id: I1e715fa5ee15533a87ca8b858734e23aefd6ddc2 Co-developed-by: Cursor <[email protected]> Co-authored-by: ralf0131 <[email protected]>
…e Studio Change-Id: I2d54f077a3fdeafcf0c4e6d82fb3ebdb9f95a39b Co-developed-by: Cursor <[email protected]> Co-authored-by: ralf0131 <[email protected]>
223dd71 to
b489fa8
Compare
Description
This PR updates the README.md documentation to improve the Quick Start guide by making the LoongCollector/Jaeger setup optional, adding comprehensive AgentScope Studio integration with trace data export configuration, updating AgentScope repository links, and reorganizing the list of supported AI frameworks to clearly distinguish between LoongSuite enhanced instrumentations and upstream OpenTelemetry instrumentations.
Changes Made
Made Jaeger section optional: Updated the "Forwarding OTLP Data to Jaeger via LoongCollector" section heading to "(Optional) Forwarding OTLP Data to Jaeger via LoongCollector" to clarify that this configuration is not required for basic usage.
Added AgentScope Studio section: Created a new section "Using AgentScope Studio to View Tracing Data" that includes:
pip install agentscope-studio)as_studiocommand)Added trace data export configuration: Created a subsection "Export AgentScope Data to AgentScope Studio" with:
--traces_exporter,--exporter_otlp_protocol, and--exporter_otlp_endpointflagsOTEL_SERVICE_NAME,OTEL_EXPORTER_OTLP_PROTOCOL, andOTEL_EXPORTER_OTLP_TRACES_ENDPOINTvariablesloongsuite-instrument(metrics collection is not currently supported)Updated AgentScope repository links: Changed all AgentScope links from
https://github.com/modelscope/agentscopeto the new repository URLhttps://github.com/agentscope-ai/agentscopein three locations:Reorganized AI frameworks section: Restructured the "Supported AI Frameworks and components" section into two distinct categories with explanatory text:
Fixed guide paths: Updated guide paths to correctly point to instrumentation-loongsuite directory for frameworks maintained there, and added missing guide link for MCP Client.
Fixed typo: Corrected spelling error in LoongCollector description (prodivdes → provides)
These changes provide users with clear, well-organized documentation that distinguishes between LoongSuite's enhanced instrumentations and synchronized upstream OpenTelemetry plugins, with flexible instructions for visualizing trace data using AgentScope Studio as an alternative to the Jaeger setup.
Type of change
How Has This Been Tested?
Does This PR Require a Core Repo Change?
Checklist:
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.